Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor handling of exposed entities for cloud Alexa and Google #89877

Merged
merged 16 commits into from
Apr 6, 2023
Merged

Refactor handling of exposed entities for cloud Alexa and Google #89877

merged 16 commits into from
Apr 6, 2023

Conversation

emontnemery
Copy link
Contributor

@emontnemery emontnemery commented Mar 17, 2023 •
edited

Proposed change

Refactor handling of exposed entities for cloud Alexa and Google assistant:

  • Add a common helper for controlling exposing entities to voice assistants and use it for Alexa and Google assistant
  • Entity settings are now stored in entity registry options instead of in a separate store
  • To expose new entities to Alexa, call WS command homeassistant/expose_new_entitieswith {"assistant":"cloud.alexa", "expose_new": True}
  • To expose an entity to Alexa, call WS command homeassistant/expose_entitywith {"assistant":"cloud.alexa", "entity_id": "blah.blah", "should_expose": True}
  • Existing cloud Alexa and Google assistant entity settings will be migrated from cloud store to the entity registry

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@emontnemery emontnemery requested a review from a team as a code owner March 17, 2023 16:38
@emontnemery emontnemery marked this pull request as draft March 17, 2023 16:38
@home-assistant
Copy link

Hey there @home-assistant/cloud, mind taking a look at this pull request as it has been labeled with an integration (cloud) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of cloud can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign cloud Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (homeassistant) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of homeassistant can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign homeassistant Removes the current integration label and assignees on the pull request, add the integration domain after the command.

balloob
balloob reviewed Mar 22, 2023
View reviewed changes
homeassistant/components/homeassistant/exposed_entities.py
entity_id, assistant, assistant_options
)
for listener in self._listeners.get(assistant, []):
listener()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we pass in the changed info ? Alexa for example can update individual entities.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alexa has logic to work out which entities were changed, I think that's still needed since updates are batched.

@emontnemery emontnemery changed the title Refactor handling of exposed entities for cloud Alexa Refactor handling of exposed entities for cloud Alexa and Google Mar 23, 2023
@emontnemery emontnemery reopened this Mar 27, 2023
@emontnemery emontnemery marked this pull request as ready for review March 27, 2023 18:49
@emontnemery emontnemery force-pushed the cloud_refactor_alexa_expose_entities branch from 81f4353 to aa9798e Compare April 4, 2023 12:07
balloob
balloob reviewed Apr 6, 2023
View reviewed changes
homeassistant/components/homeassistant/exposed_entities.py
@websocket_api.require_admin
@websocket_api.websocket_command(
{
vol.Required("type"): "homeassistant/expose_new_entities/set",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you think that we should keep this a bit more generic as set_options ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure. The only other option today is 2fa override for Google which also stores data in entity options but has its own API.
It's a bit strange that exposed_entities knows about other options, that's why I kept it separated.
We can unify if it grows beyond that maybe?

@balloob balloob merged commit 44c89a6 into dev Apr 6, 2023
44 of 45 checks passed
@balloob balloob deleted the cloud_refactor_alexa_expose_entities branch April 6, 2023 17:09
@github-actions github-actions bot locked and limited conversation to collaborators Apr 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@balloob balloob balloob approved these changes

Assignees
No one assigned
Labels
cla-signed core has-tests integration: cloud integration: homeassistant Quality Scale: internal Quality Scale: No score
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@emontnemery @balloob